This adds a simple script to mdBook that automatically generates docs for all the framework structs in TOML format + updates all missing TOML comments.

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The patch introduces enhancements and new features across various components of the project, focusing on the development environment, blockchain components, Chainlink nodes, and Docker utilities. These changes aim to improve configuration documentation, extend functionality, and refine the structure for better clarity and usability.

What

• .github/workflows/docs.yml

  • Disabled automatic triggering for main branch and tags to possibly streamline the documentation deployment process.
  • Added steps for setting up Go and generating TOML examples, which likely aims at improving documentation or config file generation.

• book/Makefile

  • Introduced a new toml target, executing a Go program that seems to generate documentation or configuration examples in TOML format.

• book/README.md

  • Updated the instruction to include the toml generation step, enhancing the setup guide for local documentation or configuration preparation.

• book/book.toml

  • No effective change; an end-of-file newline was removed.

• book/go.mod & book/go.sum

  • Created a Go module within the book directory, adding dependencies, which suggests the introduction of Go-based tooling for documentation or configuration purposes.

• book/src/SUMMARY.md

  • Added a "Developer Environment" section with a nested "Configuration" subsection, indicating an expansion of the documentation to cover development setup and configuration in more detail.

• book/src/framework/developer_environment/overview.md & toml.md

  • Added new documentation files, providing detailed information on setting up a developer environment and explaining configuration options, enhancing the project's documentation for developers.

• book/src/toml.toml

  • Introduced a comprehensive TOML file, likely serving as an example or template for configuration, documenting various components and their parameters in detail.

• book/tomldoc.go

  • Added a new Go program for generating TOML documentation or configuration examples, supporting the enhanced documentation effort.

• framework/components/blockchain/blockchain.go, canton.go, sui.go

  • Updated and added comments to struct fields to improve clarity and documentation of blockchain component configurations.

• framework/components/clnode/clnode.go

  • Enhanced documentation and clarity of Chainlink node configuration structures through updated comments.

• framework/components/fake/fake.go

  • Improved the documentation of the fake HTTP server component through detailed comments on configuration options.

• framework/components/postgres/postgres.go

  • Enhanced the PostgreSQL component configuration documentation with detailed comments on struct fields.

• framework/components/simple_node_set/node_set.go

  • Added detailed comments to the node set configuration struct, improving documentation and clarity.

• framework/docker.go

  • Enhanced documentation of Docker utility functions, especially around container resource configuration.

• framework/go.mod

  • Introduced module replacements, likely for local development or documentation purposes, pointing to local paths for certain dependencies.